/**
 * AjLog - The AspectJ based logging facade
 * 
 * Copyright (C) 2009 - 2010, Marko Umek. All rights reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ajlog.core.message.segment;

import org.ajlog.core.profiling.IProfilingResult;

/**
 * IMessageSegment is responsible for evaluating a message segment
 * 
 * @author Marko Umek
 * 
 */
public interface IMessageSegment {

    /**
     * buildDynamicMessage will be used for dynamic message building
     * 
     * @param messageBuilder
     *            the message builder instance.
     * @param paramValues
     *            the actual parameter values
     * 
     */
    public void buildDynamicMessage(final StringBuilder messageBuilder, final Object[] paramValues);

    /**
     * buildDynamicMessage will be used for dynamic message building
     * 
     * @param messageBuilder
     *            the message builder instance.
     * @param paramValues
     *            the actual parameter values
     * @param retval
     *            the return value
     * 
     */
    public void buildDynamicMessage(final StringBuilder messageBuilder, final Object[] paramValues, final Object retval);

    /**
     * buildDynamicMessage will be used for dynamic message building
     * 
     * @param messageBuilder
     *            the message builder instance.
     * @param paramValues
     *            the actual parameter values
     * @param retval
     *            the return value
     * @param profilingResult
     *            the profiling result
     * 
     */
    public void buildDynamicMessage(final StringBuilder messageBuilder, final Object[] paramValues, final Object retval,
            final IProfilingResult profilingResult);

    /**
     * buildMessage will be used for dynamic message building
     * 
     * @param messageBuilder
     *            the message builder instance.
     * @param paramValues
     *            the actual parameter values
     * @param exception
     *            the exception
     */
    public void buildDynamicMessage(final StringBuilder messageBuilder, final Object[] paramValues, final Exception exception);

    /**
     * buildMessage will be used for dynamic message building
     * 
     * @param messageBuilder
     *            the message builder instance.
     * @param paramValues
     *            the actual parameter values
     * @param exception
     *            the exception
     * @param profilingResult
     *            the profiling result
     */
    public void buildDynamicMessage(final StringBuilder messageBuilder, final Object[] paramValues, final Exception exception,
            final IProfilingResult profilingResult);
}
